STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4 R3 R2

E.2 StructureDefinition: EHRSRLE-Provenance

This profile is marked as a draft.

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/ehrsrle-provenance

Defines the elements to be supported within the Provenance resource in order to conform with the Electronic Health Record System Functional Model Record Lifecycle Event standard

This profile was published on Fri, Jan 31, 2014 00:00+1100 as a draft by Health Level Seven International (Electronic Health Record).

E.2.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Provenance.

Summary

Must-Support: 11 elements

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance I0..*Who, What, When for a set of resources
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... target S∑1..*Reference(Resource)Target Reference(s) (usually version specific)
... period S∑0..1PeriodWhen the activity occurred
... recorded S∑1..1instantWhen the activity was recorded / updated
... reason S∑0..*CodingReason the activity is occurring
Binding: PurposeOfUse (extensible)
... activity S∑0..1CodingActivity that occurred
Binding: ProvenanceEventCurrentState (extensible)
... location S∑0..1Reference(Location)Where the activity occurred, if relevant
... policy S∑0..*uriPolicy or plan the activity was defined by
... agent S∑1..*BackboneElementActor involved
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... role ∑1..1CodingWhat the agents involvement was
Binding: ProvenanceParticipantRole (extensible)
.... actor S∑0..1Reference(Practitioner | RelatedPerson | Patient | Device | Organization)Individual, device or organization playing role
.... userId S∑0..1IdentifierAuthorization-system identifier for the agent
.... relatedAgent ∑0..*BackboneElementTrack delegation between agents
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... type ∑1..1CodeableConceptType of relationship between agents
Binding: v3 Code System RoleLinkType (example)
..... target ∑1..1uriReference to other agent in this resource by identifier
... entity ∑0..*BackboneElementAn entity used in this activity
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... role ∑1..1codederivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required)
.... type ∑1..1CodingThe type of resource in this entity
Binding: ResourceType (extensible)
.... reference ∑1..1uriIdentity of entity
.... display ∑0..1stringHuman description of entity
.... agent ∑0..*Unknown reference to #Provenance:ehrsrle-provenance.agent
Entity is attributed to this agent
... signature S∑0..*SignatureSignature on target

doco Documentation for this format

todo

This structure is derived from Provenance.

Summary

Must-Support: 11 elements

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance I0..*Who, What, When for a set of resources
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... target S∑1..*Reference(Resource)Target Reference(s) (usually version specific)
... period S∑0..1PeriodWhen the activity occurred
... recorded S∑1..1instantWhen the activity was recorded / updated
... reason S∑0..*CodingReason the activity is occurring
Binding: PurposeOfUse (extensible)
... activity S∑0..1CodingActivity that occurred
Binding: ProvenanceEventCurrentState (extensible)
... location S∑0..1Reference(Location)Where the activity occurred, if relevant
... policy S∑0..*uriPolicy or plan the activity was defined by
... agent S∑1..*BackboneElementActor involved
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... role ∑1..1CodingWhat the agents involvement was
Binding: ProvenanceParticipantRole (extensible)
.... actor S∑0..1Reference(Practitioner | RelatedPerson | Patient | Device | Organization)Individual, device or organization playing role
.... userId S∑0..1IdentifierAuthorization-system identifier for the agent
.... relatedAgent ∑0..*BackboneElementTrack delegation between agents
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... type ∑1..1CodeableConceptType of relationship between agents
Binding: v3 Code System RoleLinkType (example)
..... target ∑1..1uriReference to other agent in this resource by identifier
... entity ∑0..*BackboneElementAn entity used in this activity
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... role ∑1..1codederivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required)
.... type ∑1..1CodingThe type of resource in this entity
Binding: ResourceType (extensible)
.... reference ∑1..1uriIdentity of entity
.... display ∑0..1stringHuman description of entity
.... agent ∑0..*Unknown reference to #Provenance:ehrsrle-provenance.agent
Entity is attributed to this agent
... signature S∑0..*SignatureSignature on target

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

E.2.2 Terminology Bindings

PathNameConformanceValueSet
Provenance.languageCommon LanguagesextensibleCommon Languages
Provenance.reasonPurposeOfUseextensiblePurposeOfUse
Provenance.activityProvenanceEventCurrentStateextensibleProvenanceEventCurrentState
Provenance.agent.roleProvenanceParticipantRoleextensibleProvenanceParticipantRole
Provenance.agent.relatedAgent.typev3 Code System RoleLinkTypeexamplev3 Code System RoleLinkType
Provenance.entity.roleProvenanceEntityRolerequiredProvenanceEntityRole
Provenance.entity.typeResourceTypeextensibleResourceType

E.2.3 Constraints

IdPathDetailsRequirements
dom-2ProvenanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1ProvenanceIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4ProvenanceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3ProvenanceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
.